/*******************************************************************************
 * Copyright 2016, 2017 vanilladb.org contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package org.vanilladb.core.storage.buffer;

import org.vanilladb.core.sql.Constant;
import org.vanilladb.core.sql.Type;

/**
 * An interface used to initialize a new block on disk. There will be an
 * implementing class for each "type" of disk block.
 */
public abstract class PageFormatter {
	/**
	 * Initializes a page, whose contents will be written to a new disk block.
	 * This method is called only during the method {@link Buffer#assignToNew}.
	 * 
	 * @param buf
	 *            a buffered page
	 */
	public abstract void format(Buffer buf);
	
	protected void setVal(Buffer buf, int offset, Constant val) {
		buf.setVal(offset, val);
	}
	
	protected Constant getVal(Buffer buf, int offset, Type type) {
		return buf.getVal(offset, type);
	}
}
